home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / dparm12.zip / PAUZ15.ZIP / PAUZ.DOC next >
Text File  |  1991-02-06  |  5KB  |  138 lines
  1.                                PAUZ 1.5
  2.  
  3.                Specifiable wait function for batch files
  4.  
  5.                                   by
  6.                                Bob Eyer
  7.                              [73230,2620]
  8.  
  9.                               Feb 6, 1991
  10.  
  11.      Syntax
  12.      ------
  13.      PAUZ StopCharacter [WaitSeconds|TargetTime]
  14.  
  15.      Definitions
  16.      -----------
  17.      StopCharacter:  The upper or lower case character  the  user  must
  18.                      press  to continue processing before PAUZ finishes
  19.                      waiting.   PAUZ's interpretation   of   the   stop
  20.                      character is not case-insensitive.
  21.  
  22.                      If  SPACE  is entered for StopCharacter, PAUZ will
  23.                      use the Spacebar as the key to hit  for  continued
  24.                      processing.  If ANY is used then PAUZ uses any key
  25.                      for this purpose.
  26.  
  27.      Second parameter (optional):
  28.      Either -
  29.      WaitSeconds:    The  maximum  number  of  seconds  PAUZ will delay
  30.                      processing.
  31.      or -
  32.      TargetTime:     The time  in  HH:MM  format  at  which  PAUZ  will
  33.                      continue   processing.   This  parameter  must  be
  34.                      entered with a colon,  in  formats  like  8:40  or
  35.                      08:40.   Postmeridian  times  must  be  entered in
  36.                      24-hour format.
  37.  
  38.      Where  the second parameter is not mentioned, PAUZ will operate in
  39.      wait rather than target mode, using defaults as discussed below in
  40.      the section entitled "WaitSeconds Defaults".
  41.  
  42.      Discussion
  43.      ----------
  44.      This  program was written to solve a problem posed by Jim Simpson,
  45.      of Canada Remote Systems, of supplying a replacement for DOS PAUSE
  46.      which allows the user to specify which key to use for interrupting
  47.      the pause, with varying defaults for each key and an  error  level
  48.      return  to  enable  the  user  to  branch  batch  file processing,
  49.      depending on whether the pause wait was successfully interrupted.
  50.  
  51.      PAUZ  i/o  is redirectable.  So, PAUZ can be used to assist design
  52.      of batch file-based remote door programs.
  53.  
  54.      Examples
  55.      --------
  56.      The  following  shows  how  to  use PAUZ with the program's return
  57.      message:
  58.  
  59.      (1)
  60.      PAUZ ANY
  61.      Press any key or wait 30 seconds to continue ...
  62.  
  63.      Pressing  any  key  will return control to DOS (or the batch file)
  64.      with  error  level  1;   otherwise,   control   will   be   passed
  65.      automatically  with  error  level  0 if no key is pressed after 30
  66.      seconds have elapsed.
  67.  
  68.      (2)
  69.      PAUZ SPACE
  70.      Press [SPACEBAR] or wait 30 seconds to continue ...
  71.  
  72.      (3)
  73.      PAUZ A
  74.      Press [A] or wait 15 seconds to continue ...
  75.  
  76.      (4)
  77.      PAUZ A 75
  78.      Press [A] or wait 75 seconds to continue ...
  79.  
  80.      Note  the  effect  of  overriding  the 15 second default for the A
  81.      stopcharacter (see below).
  82.  
  83.      (5)
  84.      PAUZ A 14:20
  85.      Press [A] or wait until 14:20 to continue ...
  86.  
  87.      Notice that the use of a target time  causes  PAUZ  to  alter  the
  88.      format of its wait message.
  89.  
  90.      WaitSeconds Defaults
  91.      --------------------
  92.      In the event the user does not mention WaitSeconds on the  command
  93.      line,  PAUZ  uses  the  identity of StopCharacter to determine the
  94.      magnitude of the maximum wait time.  The following table indicates
  95.      the defaults supported:
  96.  
  97.           StopCharacter        Default Wait Time
  98.  
  99.                  A               15 seconds
  100.  
  101.                  B               60
  102.  
  103.                  C              120
  104.  
  105.                  D              240
  106.  
  107.      Anything  used  for  StopCharacter  other  than A, B, C, or D will
  108.      cause PAUZ to use 30 seconds as the default wait time.
  109.  
  110.      Of  course,  in the event the user does mention WaitSeconds on the
  111.      command line, the user's wait  time  will  always  override  these
  112.      defaults.
  113.  
  114.      Error Levels
  115.      ------------
  116.      PAUZ's  normal  termination  is  defined  as an uninterrupted PAUZ
  117.      run - i.e.  without touching any  stop  character  key.   In  this
  118.      case, PAUZ returns an error level of 0.
  119.  
  120.      If  the  user  interrupts  PAUZ processing by hitting the required
  121.      stop character, then PAUZ returns an error level of 1.
  122.  
  123.      DISCLAIMER:
  124.      ==========
  125.      This program is circulated as public domain without any  guarantee
  126.      or  warranty;  and  the  user, by downloading this program, or any
  127.      variant thereof or by receiving it or any of its versions  in  any
  128.      other  form, agrees to accept full responsibility for its use.  It
  129.      is therefore understood that the user accepts this program or  any
  130.      previous  version  as  is.
  131.  
  132.      Bob Eyer                  The author may also be reached at
  133.      Compuserve [73230,2620]   ROSE MEDIA 416-733-2285 (Main Conf)
  134.      Toronto                   or
  135.      Canada                    CANADA REMOTE 416-629-7044 (IBM Conf)
  136.      -------------------------------------------------------------
  137.      End of documentation
  138.